Skip to main content

FlowGptPrompt Properties

An object defining properties for the FlowGptPrompt class.

Key

A unique identifier for the workflow step.

Type: string


WorkflowCodeInstance

The workflow code instance associated with the flow object.

Type: IWorkflowCode


CachedDMObjects

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


ExecutionType

Indicates the execution type of the GPT query.

Type: GptQueryType
Accepted Values:

NameValue
InfoExtractor1
CustomPrompt2
Decider3

QueryId

Specifies the unique identifier for the GPT query.

Type: long


Structure

Defines the structure of the GPT query return type.

Type: GPTReturnStructure


QueryName

The name of the GPT query to be executed.

Type: string


TypeCode

The type code associated with the flow object.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

QueryParameters

A list of parameters used for the GPT query execution.

Type: List<GPTParameter>


ResumeOnError

Determines whether the query execution should continue when an error occurs.

Type: bool


ErrorOptions

Defines error-related options for the API step.

Type: IFlowErrorOptions


Name

Name for the workflow step.

Type: string


ResultObjectName

Specifies the object name to store the query results.

Type: string


QueryResult

Holds the result of the executed query.

Type: object


Caption

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>